Vcenter Namespaces Instances UpdateSpec

Vcenter Namespaces Instances UpdateSpec
Vcenter Namespaces Instances UpdateSpec

The Vcenter Namespaces Instances UpdateSpec schema contains the specification required to update the configuration on the namespace. This schema is applied partially, and only the specified fields will replace or modify their existing counterparts.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "description": "string",
    "resource_spec": {},
    "access_list": [
        {
            "subject_type": "string",
            "subject": "string",
            "domain": "string",
            "role": "string",
            "identity_provider": "string"
        }
    ],
    "storage_specs": [
        {
            "policy": "string",
            "limit": 0
        }
    ],
    "vm_service_spec": {
        "content_libraries": [
            "string"
        ],
        "vm_classes": [
            "string"
        ]
    },
    "content_libraries": [
        {
            "content_library": "string",
            "writable": false,
            "allow_import": false,
            "resource_naming_strategy": "string"
        }
    ],
    "network_spec": {
        "network_provider": "string",
        "vpc_config": {
            "default_subnet_size": 0,
            "private_cidrs": [
                {
                    "address": "string",
                    "prefix": 0
                }
            ]
        }
    },
    "zones": [
        {
            "name": "string",
            "vm_reservations": [
                {
                    "reserved_vm_class": "string",
                    "count": 0
                }
            ],
            "cpu_limit_mhz": 0,
            "cpu_reservation_mhz": 0,
            "memory_limit_mib": 0,
            "memory_reservation_mib": 0,
            "disallow_unreserved_direct_path_usage": false
        }
    ]
}
string
description
Optional

Description for the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the description of the namespace will not be modified.

object
resource_spec
Optional

Resource quota updates on the namespace. Refer to Vcenter NamespaceManagement NamespaceResourceOptions Info.update_resource_quota_type and use GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for retrieving the type for the value for this field. For an example of this, see Vcenter Namespaces ResourceQuotaOptionsV1Update.

This property was added in vSphere API 7.0.0.0.

If missing or null, the resource constraints on the namespace will not be modified.

access_list
Optional

Access control associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, access controls on the namespace will not be modified. Existing pods from users will continue to run.

storage_specs
Optional

Storage associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, storage policies and their limit will not be modified. Pods which are already using persistent storage from the earlier version of storage policies will be able to access them till the datastores are attached to the worker nodes.

vm_service_spec
Optional

VM Service specification associated with the namespace.

NOTE: Any change in the VM Service Content Libraries associated with the namespace will be updated and merged with the the Content Library list in VM Image Service. If {UpdateSpec#contentLibraries} is unset, the Content Libraries specified here will be honored if no writable Content Libraries are removed from the current Content Library list by GET /vcenter/namespaces/instances/{namespace} operation, otherwise InvalidArgument error will be thrown.

This property was added in vSphere API 7.0.2.00100.

If missing or null, the Content Libraries get configured based on the values in {UpdateSpec#contentLibraries}, if it is specified.

content_libraries
Optional

List of Content Libraries used by the VM Image Service. This list refers to existing Content Libraries in vSphere inventory.

The Content Libraries specified in {VMServiceSpec#contentLibraries} will also be included in this list but will be read-only by default to users.

If the same Content Library is present both here and in {VMServiceSpec#contentLibraries}, then:

  • The Content Library is only surfaced to users once.
  • The settings here are honored.

NOTE: Any change in the VM Image Service Content Libraries associated with the namespace will be updated and merged with the Content Library list in Vcenter Namespaces Instances VMServiceSpec. If {UpdateSpec#vmServiceSpec#contentLibraries} is unset, the Content Libraries specified here will be honored and the Content Libraries removed from the current Content Library list by GET /vcenter/namespaces/instances/{namespace} operation will also be removed from VM Service.

This property was added in vSphere API 8.0.2.0.

If missing or null, the Content Libraries get configured based on the values in {UpdateSpec#vmServiceSpec#contentLibraries}, if it is specified.

network_spec
Optional

Network related configurations to be updated with this namespace.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

zones
Optional

List of Vcenter Namespaces Instances ZoneSpec to configure vSphere Zones for this namespace.

This property was added in vSphere API 9.0.0.0.

If missing or null, the existing vSphere Zones on the namespace will not be modified.